home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / c / least.doc < prev    next >
Text File  |  1996-09-07  |  9KB  |  205 lines
  1.  
  2. NAME
  3.  
  4.       Least - simple and handsome text viewer
  5.  
  6. VERSION
  7.  
  8.       0.04 (Sorry, no higher  version  number  possible, because
  9.             Least  emerges  only  from a little  one day  screen
  10.             hack.)
  11.  
  12. SYNOPSIS
  13.  
  14.       Least [<filename>]
  15.  
  16. DISCLAIMER
  17.  
  18.       Although  every effort  has been  made to  have a  correct
  19.       function  depending on the  description in this  document,
  20.       the author is not  responsible for  any damage  the use of
  21.       this program does and expresses no  warranty on the fault-
  22.       lessness of the program.
  23.  
  24.       You are  entirely  responsible  on your  own  risk for all
  25.       things sustained by the legal use or misuse.
  26.  
  27. PURPOSE
  28.  
  29.       Least is  for all  those folks distributing texts and docs
  30.       without having an adequate displaying tool to supply with.
  31.       You need no granted  permission from me, if you distribute
  32.       Least in unmodified form and include always this document.
  33.  
  34. DESCRIPTION
  35.  
  36.       Least is a simple tool for the purpose of viewing text fi-
  37.       les of all kind like More, Less, MuchMore etc. The special
  38.       advantage of  Least is its short size, fast loading of fi-
  39.       les, very  fast string  searching (Least makes  use of the
  40.       Boyer-Moore  algorithm) and  low (!)  functionality. It is
  41.       only intended to supply the most frequently used functions
  42.       of a text  viewer (who  uses such  despised BASIC commands
  43.       like goto line # ?).
  44.  
  45.       Least uses for its own window the size of the actual Work-
  46.       bench  screen, so  overscan  mode is  supported, too. Like
  47.       other tools in this category Least maintains a status line
  48.       appearing at the top of the  window and maintaining  small
  49.       pieces of possible information about the current file. You
  50.       will see the  first  portion (25 characters) of  the file-
  51.       name, the filesize measured in  bytes, the number of lines
  52.       and the number of the line currently been displayed at the
  53.       top of the window.
  54.  
  55.       Least also  supports the  great  FileRequester from Reque-
  56.       ster.Library. In  a  special  version  of  Least -  called
  57.       LeastP - you are able to load and view files crunched with
  58.       the PowerPacker.
  59.  
  60.       For those who don't like to completely read  this document
  61.       to become familiar with the commands, Least  provides also
  62.       a short online help.
  63.  
  64. USAGE
  65.  
  66.       If you invoke Least from CLI you just type Least following
  67.       a blank and  afterwards the  name of the  text  file to be
  68.       displayed.
  69.  
  70.       Workbench  users are  recommended to  insert  the  name of
  71.       Least including its search  path in the Default Tool field
  72.       of the info-file belonging to the desired text file (click
  73.       once at the icon of  the text  file  and  choose  from the
  74.       workbench  menu the Info  entry. The Info  window appears.
  75.       Now you can click with the left mouse  button in the field
  76.       Default  Tool. There you  can  type the name as  mentioned
  77.       above. Afterwards  click at  the Save  field in the  lower
  78.       left corner.). Now  the only  thing you  must do is double
  79.       clicking at the icon of your text file.
  80.  
  81.       Alternatively you can type from CLI only Least (from Work-
  82.       bench only  double click  at Least's icon) and Least  will
  83.       bring up a file requester to select a valid file name.
  84.  
  85. COMMANDS
  86.  
  87.       <CRSR UP> , <BACKSPACE>       : Show previous line
  88.       <CRSR DOWN> , <SPACE>         : Show next line
  89.       <SHIFT><CRSR UP> , <PGUP>     : Show previous page
  90.       <SHIFT><CRSR DOWN> , <PGDN>   : Show next page
  91.       <ALT><CRSR UP>                : Scroll 10 lines up
  92.       <ALT><CRSR DOWN>              : Scroll 10 lines down
  93.       T , <HOME> , <CTRL><CRSR UP>  : Display top of file
  94.       B , <END> , <CTRL><CRSR DOWN> : Display bottom of file
  95.       F , S                         : Search string
  96.                                       (Req.Library necessary)
  97.       N                             : Next occurence
  98.       L , O                         : Display another file
  99.                                       (Req.Library necessary)
  100.       H , <HELP>                    : Provides short online help
  101.       Q , X , <ESC> , CloseGadget   : Exit from Least
  102.  
  103. SPEED
  104.  
  105.       One of the  outstanding features  Least  supports, is it's
  106.       high  speed file loading. Let's  say  you have  to load an
  107.       approximately  150k byte  large  file from  your  internal
  108.       floppy disk, not formatted with the new FFS. The following
  109.       table  shows how much time loading took, when using one of
  110.       the booked editors or text viewer.
  111.  
  112.              Tool        ¦  Version  ¦  Kind  ¦  Time [s]
  113.             -------------+-----------+--------+-----------
  114.              Least       ¦   0.04    ¦ Viewer ¦     7!!
  115.              CygnusEd    ¦   1.12    ¦ Editor ¦     8
  116.              MicroEmacs  ¦   1.40    ¦ Editor ¦    12
  117.              Ed          ¦   2.00    ¦ Editor ¦    12
  118.              Z           ¦   2.20    ¦ Editor ¦    13
  119.              MuchMore    ¦   3.00    ¦ Viewer ¦    13
  120.  
  121.       One rule one can derive from this list:
  122.  
  123.          The higher the version number, the slower the speed.
  124.  
  125.  
  126.       Editors like Less and More are  left out of consideration,
  127.       because  they did not load the  whole file (only  the dis-
  128.       played  portion, while  the file  remains open  during the
  129.       whole viewing process).
  130.  
  131.       To have a look at the fast string searching, only take one
  132.       extremely  large file - approximately 2 Mega byte - , load
  133.       it  with one of those editors or  viewers mentioned above, 
  134.       search  for one string  that only occurs at the end of the
  135.       file, compare the times each tool took  for this operation
  136.       with that of Least ... and enjoy.
  137.  
  138. SPECIAL FEATURE
  139.  
  140.       As a counteraction against the continually  growing number
  141.       of viruses, Least comes  with an integrated link virus de-
  142.       tector. Its only purpose is to check, if  Least got infec-
  143.       ted by a virus. But it is not  possible to scan other exe-
  144.       cutable files.
  145.  
  146. BUGS (better say LIMITS)
  147.  
  148.       Depending on the way Least's internal data structures were
  149.       implemented, two known limits exist.
  150.       First, displaying lines longer than the actual window size
  151.       isn't supported. That  means, that indeed the line is com-
  152.       pletely  displayed, but in two lines on the screen. Inter-
  153.       nally only one line is counted. So as the  effect is noti-
  154.       ced that the uppermost line scrolls out of the display and
  155.       will never been seen again ...
  156.       If you like to see all of your document use shorter lines.
  157.  
  158.       The  second  problem arises  when using control  codes for
  159.       bold,  italics, underline  etc. All lines in the  document
  160.       using such codes must end  with a reset to the normal dis-
  161.       play mode. If you don't pay any attention on this, the at-
  162.       tuned  mode remains  active and you  will see  what occurs
  163.       when scrolling backwards ...
  164.  
  165. SOURCE
  166.  
  167.       Source isn't distributed yet, because that would lead to a
  168.       great  variety of different  versions of the program. Also
  169.       in that case the  virus detection  algorithm  would become
  170.       public (especially to programmers of viruses).
  171.  
  172. COPYRIGHT
  173.  
  174.       No copyright. Use  and copy as you like it, but  neverthe-
  175.       less only distribute in unmodified form and together  with
  176.       this document. You may freely  distribute it as long as no
  177.       charge is made other than a fee to recover costs for copy-
  178.       ing and distribution. The fee should not be  higher as ob-
  179.       taining a  disk from  Fred Fish. The distributor agrees to
  180.       stop distributing of all files belonging to this document,
  181.       if requested by the author.
  182.  
  183. TRADEMARKS
  184.  
  185.       PowerPacker           © 1990 by Nico François
  186.       Requester.Library     © 1989 by Colin Fox and Bruce Dawson
  187.  
  188. AUTHOR
  189.  
  190.       If you have any important  questions, remarks or you  want
  191.       to propose  any  fundamental  enhancements, don't  fail to
  192.       contact :
  193.  
  194.                            Thorsten Koschinski
  195.                                Meisenweg 10
  196.                              W-2082 Uetersen
  197.                        Federal Republic of Germany
  198.  
  199.       Monetary donations of all kind are not welcome (don't mess
  200.       with those declaring themself as starving artists). If you
  201.       still feel  forced to do anything charitable, perhaps send
  202.       any program or other stuff of your own.
  203.  
  204.                                       (formatted 03-August-1992)
  205.